<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilsecure: XilSecure KAT Client APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilsecure
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xsecure__kat__client__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilSecure KAT Client APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1eb14922f650174090f0fdca7345a517"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga1eb14922f650174090f0fdca7345a517">XSecure_AesDecryptKat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga1eb14922f650174090f0fdca7345a517"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform decrypt KAT on AES engine.  <a href="#ga1eb14922f650174090f0fdca7345a517">More...</a><br/></td></tr>
<tr class="separator:ga1eb14922f650174090f0fdca7345a517"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga406813136028273d32d55dc2dd9f91c7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga406813136028273d32d55dc2dd9f91c7">XSecure_AesDecryptCmKat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga406813136028273d32d55dc2dd9f91c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform KAT on AES DPA countermeasure KAT.  <a href="#ga406813136028273d32d55dc2dd9f91c7">More...</a><br/></td></tr>
<tr class="separator:ga406813136028273d32d55dc2dd9f91c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e00313e2e3f47bfb6dbc463889971c4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga7e00313e2e3f47bfb6dbc463889971c4">XSecure_RsaPublicEncKat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga7e00313e2e3f47bfb6dbc463889971c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform RSA encrypt KAT.  <a href="#ga7e00313e2e3f47bfb6dbc463889971c4">More...</a><br/></td></tr>
<tr class="separator:ga7e00313e2e3f47bfb6dbc463889971c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0743d577968e560b692122ab03e22d35"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga0743d577968e560b692122ab03e22d35">XSecure_Sha3Kat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga0743d577968e560b692122ab03e22d35"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform SHA3 KAT.  <a href="#ga0743d577968e560b692122ab03e22d35">More...</a><br/></td></tr>
<tr class="separator:ga0743d577968e560b692122ab03e22d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf5996378299f1f95c9a13592febad58a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#gaf5996378299f1f95c9a13592febad58a">XSecure_EllipticSignVerifyKat</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#ga678d756780f5569d245a8fe5fe7606c7">XSecure_EccCrvClass</a> CurveClass)</td></tr>
<tr class="memdesc:gaf5996378299f1f95c9a13592febad58a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform ECC sign verify KAT.  <a href="#gaf5996378299f1f95c9a13592febad58a">More...</a><br/></td></tr>
<tr class="separator:gaf5996378299f1f95c9a13592febad58a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaff0e846438561c899db7c1ce4b00817c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#gaff0e846438561c899db7c1ce4b00817c">XSecure_AesEncryptKat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:gaff0e846438561c899db7c1ce4b00817c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform encrypt KAT.  <a href="#gaff0e846438561c899db7c1ce4b00817c">More...</a><br/></td></tr>
<tr class="separator:gaff0e846438561c899db7c1ce4b00817c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec9500ffdf3138f3e71404a3bd955972"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#gaec9500ffdf3138f3e71404a3bd955972">XSecure_RsaPrivateDecKat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:gaec9500ffdf3138f3e71404a3bd955972"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform RSA private decrypt KAT.  <a href="#gaec9500ffdf3138f3e71404a3bd955972">More...</a><br/></td></tr>
<tr class="separator:gaec9500ffdf3138f3e71404a3bd955972"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e9df7a4b6b28b1827cf11be03a97e0d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga5e9df7a4b6b28b1827cf11be03a97e0d">XSecure_EllipticSignGenKat</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#ga678d756780f5569d245a8fe5fe7606c7">XSecure_EccCrvClass</a> CurveClass)</td></tr>
<tr class="memdesc:ga5e9df7a4b6b28b1827cf11be03a97e0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform ECC sign generate KAT.  <a href="#ga5e9df7a4b6b28b1827cf11be03a97e0d">More...</a><br/></td></tr>
<tr class="separator:ga5e9df7a4b6b28b1827cf11be03a97e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b74e15ff3cab4a891179ef46efe576f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga7b74e15ff3cab4a891179ef46efe576f">XSecure_TrngKat</a> (XSecure_ClientInstance *InstancePtr)</td></tr>
<tr class="memdesc:ga7b74e15ff3cab4a891179ef46efe576f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to perform TRNG KAT and health tests.  <a href="#ga7b74e15ff3cab4a891179ef46efe576f">More...</a><br/></td></tr>
<tr class="separator:ga7b74e15ff3cab4a891179ef46efe576f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5c6cfe1443dd4993a5f16b871c9b47ff"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga5c6cfe1443dd4993a5f16b871c9b47ff">XSecure_UpdateHnicKatStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a> KatOp, u32 KatMaskLen, u32 *KatMask)</td></tr>
<tr class="memdesc:ga5c6cfe1443dd4993a5f16b871c9b47ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to set or clear kat mask of HNIC.  <a href="#ga5c6cfe1443dd4993a5f16b871c9b47ff">More...</a><br/></td></tr>
<tr class="separator:ga5c6cfe1443dd4993a5f16b871c9b47ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7e90b1b5c26da72eee23a3bf837e71e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#gab7e90b1b5c26da72eee23a3bf837e71e">XSecure_UpdateCpm5NKatStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a> KatOp, u32 KatMaskLen, u32 *KatMask)</td></tr>
<tr class="memdesc:gab7e90b1b5c26da72eee23a3bf837e71e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to set or clear kat mask of CPM5N.  <a href="#gab7e90b1b5c26da72eee23a3bf837e71e">More...</a><br/></td></tr>
<tr class="separator:gab7e90b1b5c26da72eee23a3bf837e71e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c28d3d328d58ef5008d2c4304643e6c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga0c28d3d328d58ef5008d2c4304643e6c">XSecure_UpdatePcideKatStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a> KatOp, u32 KatMaskLen, u32 *KatMask)</td></tr>
<tr class="memdesc:ga0c28d3d328d58ef5008d2c4304643e6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to PLM to set or clear kat mask of PCIDE.  <a href="#ga0c28d3d328d58ef5008d2c4304643e6c">More...</a><br/></td></tr>
<tr class="separator:ga0c28d3d328d58ef5008d2c4304643e6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2181a9227c88d3b6379f5213d3037625"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xsecure__kat__client__apis.html#ga2181a9227c88d3b6379f5213d3037625">XSecure_UpdatePkiKatStatus</a> (XSecure_ClientInstance *InstancePtr, <a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a> KatOp, u32 KatMaskLen, u32 *KatMask)</td></tr>
<tr class="memdesc:ga2181a9227c88d3b6379f5213d3037625"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets or clears KAT mask of PKI.  <a href="#ga2181a9227c88d3b6379f5213d3037625">More...</a><br/></td></tr>
<tr class="separator:ga2181a9227c88d3b6379f5213d3037625"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga406813136028273d32d55dc2dd9f91c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_AesDecryptCmKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform KAT on AES DPA countermeasure KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On success</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_AesDecCmKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394ea2f5dbd303625fc2c0ef8b295c9b3b992">XSECURE_API_AES_DECRYPT_CM_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga1eb14922f650174090f0fdca7345a517"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_AesDecryptKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform decrypt KAT on AES engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS When KAT Pass</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_AesDecKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394eac036db8b4c037ab3955b93d62513fb6b">XSECURE_API_AES_DECRYPT_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="gaff0e846438561c899db7c1ce4b00817c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_AesEncryptKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform encrypt KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS When KAT Pass</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_AesEncKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394eab33a5806407cf829f203f5fb0af1a806">XSECURE_API_AES_ENCRYPT_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5e9df7a4b6b28b1827cf11be03a97e0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_EllipticSignGenKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#ga678d756780f5569d245a8fe5fe7606c7">XSecure_EccCrvClass</a>&#160;</td>
          <td class="paramname"><em>CurveClass</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform ECC sign generate KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">CurveClass</td><td>Type of elliptic curve class(Prime - 0, Binary - 1)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On success</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_EllipticSignGenKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394ea0b59fb6da09265ead7ce0c53fed06d95">XSECURE_API_ELLIPTIC_SIGN_GEN_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

<p>Referenced by <a class="el" href="xilsecure__versal__ecdsa__client__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, and <a class="el" href="group__xsecure__kat__server__apis.html#ga693f088bbeaa2be1dd7a084c2bee6351">XSecure_KatIpiHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf5996378299f1f95c9a13592febad58a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_EllipticSignVerifyKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#ga678d756780f5569d245a8fe5fe7606c7">XSecure_EccCrvClass</a>&#160;</td>
          <td class="paramname"><em>CurveClass</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform ECC sign verify KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">CurveClass</td><td>Type of elliptic curve class(Prime - 0, Binary - 1)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On success</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_EllipticSignVerifyKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394ea743c67d281e7028a0a68c3d988db9801">XSECURE_API_ELLIPTIC_SIGN_VERIFY_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

<p>Referenced by <a class="el" href="xilsecure__versal__ecdsa__client__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>, and <a class="el" href="group__xsecure__kat__server__apis.html#ga693f088bbeaa2be1dd7a084c2bee6351">XSecure_KatIpiHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gaec9500ffdf3138f3e71404a3bd955972"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_RsaPrivateDecKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform RSA private decrypt KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On success</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_RsaPrivateDecKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394ea7157637ce5e02761c76b740352140f97">XSECURE_API_RSA_PRIVATE_DEC_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

<p>Referenced by <a class="el" href="group__xsecure__kat__server__apis.html#ga693f088bbeaa2be1dd7a084c2bee6351">XSecure_KatIpiHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7e00313e2e3f47bfb6dbc463889971c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_RsaPublicEncKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform RSA encrypt KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On success</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_RsaPubEncKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394ead4e0f42ca445468c1534a1e2a23a3099">XSECURE_API_RSA_PUB_ENC_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga0743d577968e560b692122ab03e22d35"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_Sha3Kat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform SHA3 KAT. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS When KAT Pass</li>
<li>XST_INVALID_PARAM If input parameters are invalid</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_ShaKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394eaa93a792a36e46e604483c25f4fbc877e">XSECURE_API_SHA3_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7b74e15ff3cab4a891179ef46efe576f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_TrngKat </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to perform TRNG KAT and health tests. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS When KAT Pass</li>
<li>XST_INVALID_PARAM If any input parameter is invalid.</li>
<li>XST_FAILURE If there is a failure </li>
</ul>
</dd></dl>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_TrngKat API and returns the status of the IPI response.</p>
<p>Send an IPI request to the PLM by using the CDO command to call XSecure_TrngKat API and returns the status of the IPI response.</p>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acafcb78231ca805fdd53c34ddc9688000a">XSECURE_API_KAT</a>, <a class="el" href="group__xsecure__common__apis.html#gga37319402ed20263002a96ca04d74394eab2a35ee2e4ab05e7234c2bdc76fc37f6">XSECURE_API_TRNG_KAT</a>, and <a class="el" href="group__xsecure__mailbox__apis.html#ga6ac5f0da32dd8fb5fcd15a7e65b492bb">XSecure_ProcessMailbox()</a>.</p>

<p>Referenced by <a class="el" href="group__xsecure__kat__server__apis.html#gaf7cb17f01c5c5542c9c2b3d6f00699d3">XSecure_KatPlatIpiHandler()</a>.</p>

</div>
</div>
<a class="anchor" id="gab7e90b1b5c26da72eee23a3bf837e71e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdateCpm5NKatStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a>&#160;</td>
          <td class="paramname"><em>KatOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>KatMaskLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>KatMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to set or clear kat mask of CPM5N. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">KatOp</td><td>Operation to set or clear KAT mask </td></tr>
    <tr><td class="paramname">KatMaskLen</td><td>Length of the KAT mask </td></tr>
    <tr><td class="paramname">KatMask</td><td>KAT mask</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36acac08da78d39f6d01df82e295363a7dc51">XSECURE_API_UPDATE_CPM5N_KAT_STATUS</a>, and <a class="el" href="group__xsecure__common__apis.html#gad6a083e727cafa4218c95e2341f62d8a">XSECURE_MIN_KAT_MASK_LEN</a>.</p>

</div>
</div>
<a class="anchor" id="ga5c6cfe1443dd4993a5f16b871c9b47ff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdateHnicKatStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a>&#160;</td>
          <td class="paramname"><em>KatOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>KatMaskLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>KatMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to set or clear kat mask of HNIC. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">KatOp</td><td>Operation to set or clear KAT mask </td></tr>
    <tr><td class="paramname">KatMaskLen</td><td>Length of the KAT mask </td></tr>
    <tr><td class="paramname">KatMask</td><td>KAT mask</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca44f09d5b48a831480a1cf114ccb1454c">XSECURE_API_UPDATE_HNIC_KAT_STATUS</a>, and <a class="el" href="group__xsecure__common__apis.html#gad6a083e727cafa4218c95e2341f62d8a">XSECURE_MIN_KAT_MASK_LEN</a>.</p>

</div>
</div>
<a class="anchor" id="ga0c28d3d328d58ef5008d2c4304643e6c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdatePcideKatStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a>&#160;</td>
          <td class="paramname"><em>KatOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>KatMaskLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>KatMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to PLM to set or clear kat mask of PCIDE. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">KatOp</td><td>Operation to set or clear KAT mask </td></tr>
    <tr><td class="paramname">KatMaskLen</td><td>Length of the KAT mask </td></tr>
    <tr><td class="paramname">KatMask</td><td>KAT mask</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS On Success</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca9e649e1f6951aa5a6dd65c119eedf6ba">XSECURE_API_UPDATE_PCIDE_KAT_STATUS</a>, and <a class="el" href="group__xsecure__common__apis.html#gad6a083e727cafa4218c95e2341f62d8a">XSECURE_MIN_KAT_MASK_LEN</a>.</p>

</div>
</div>
<a class="anchor" id="ga2181a9227c88d3b6379f5213d3037625"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XSecure_UpdatePkiKatStatus </td>
          <td>(</td>
          <td class="paramtype">XSecure_ClientInstance *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__xsecure__common__apis.html#gae9abbc75ac66f341f029869aac24c716">XSecure_KatOp</a>&#160;</td>
          <td class="paramname"><em>KatOp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>KatMaskLen</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>KatMask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets or clears KAT mask of PKI. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the client instance </td></tr>
    <tr><td class="paramname">KatOp</td><td>Operation to set or clear KAT mask </td></tr>
    <tr><td class="paramname">KatMaskLen</td><td>Length of the KAT mask </td></tr>
    <tr><td class="paramname">KatMask</td><td>Pointer to the KAT mask</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS If set or clear is successful</li>
<li>XST_FAILURE On failure </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__xsecure__common__apis.html#gga48921cbba3a5713caf7d975bedbe36aca2c3a03734f8768efe3c23fd7585e332d">XSECURE_API_UPDATE_PKI_KAT_STATUS</a>, and <a class="el" href="group__xsecure__common__apis.html#ga0a43d350be21f46c201cbfbf96e31b81">XSECURE_MAX_KAT_MASK_LEN</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
